home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / xfd_v301.zip / STRUC201.XFD < prev    next >
Text File  |  1992-05-31  |  4KB  |  73 lines
  1. Structure  V 2.01
  2. -----------------
  3.  
  4. This document will give a description of the internal format of the
  5. FileDoor/DISP-compatible tag-file.
  6.  
  7. 3th party programs (non-DISP programs) can use this structure descrip-
  8. tion to create compatible tag-files that can be accessed by FileDoor
  9. 2.xx and higher versions. FileDoor will stay compatible with this
  10. release of the structure until (at least) version 3.01 even if a new
  11. structure is implemented:
  12.  
  13.  
  14. A FileDoor/DISP-compatible tag-file <tm> will contain 1 header record
  15. (layout in FDTHea_Lay) and up to 255 data-records (layout in FDTDAT_lay)
  16.  
  17. The file is a Turbo-PASCAL typed file but can also be created with any
  18. other language. Remember that a Turbo Pascal STRING[xx] is equal to the
  19. structure ARRAY [0..xx] OF CHAR, where element 0 contains the binary
  20. length of used part of the string.
  21.  
  22. {*****************************************************************************
  23. * Usage  : FileDoor/DISP compatible TAG-file                                 *
  24. * Written: 05-01-1991                                                        *
  25. * Author : R.W. van Hoeven                                                   *
  26. * Updates: V  2.01 05-01-1991  Changes:                                      *
  27. *                              - New                                         *
  28. *****************************************************************************}
  29.    FDTHea_Lay=RECORD
  30.       FDT_ID                                            :STRING[8];
  31.       FDTAut                                            :BOOLEAN;
  32.       FDTNam                                            :STRING[40];
  33.       FDTPrg                                            :STRING[8];
  34.       FDTDes                                            :STRING[40];
  35.    END;
  36.  
  37.    FDTDat_Lay=RECORD
  38.       FDTFil                                            :STRING[12];
  39.       FDTCom                                            :STRING[87];
  40.    END;
  41.  
  42. Header.FDT_ID  must contain FDTAG201
  43. Header.FDTAut  is set to TRUE if the file is an AUTOLOAD tag-file
  44.                otherwise it is set to FALSE;
  45. Header.FDTNam  must contain the user-name as passed by the BBS;
  46. Header.FDTPrg  is the name of the door that changed the file last;
  47. Header.FDTDes  is a description that can be added by the door that
  48.                has created the file. This comment is showed to the
  49.                user in FileDoor (download);
  50.  
  51. Data__.FDTFil  is the name of the file (filename.ext format) that is
  52.                added to the tag-file.
  53. Data__.FDTCom  is not used yet. It will be used for the directory
  54.                where the program is stored. Don't use this entry
  55.                yet.
  56.  
  57.  
  58. At any given time there can be only ONE tag-file for a certain BBS
  59. line. The door must check if there is already a tag-file for that
  60. users and if so must act upon it (append to it or ask the user if
  61. it can be deleted or not and if not, terminate door).
  62.  
  63. The filename is fixed to BBSTAGFL.lll where lll is the BBS-linenumber
  64. without leading zeros. So BBSTAGFL.1 for line 1, BBSTAGFL.21 for line
  65. 21 and so on.
  66.  
  67. If a door appends to a tag-file, the door must change Header.FDTNam
  68. (and optionally Header.FDTDes). If Header.FDTAut is set, it is good
  69. practise to leave it on. If it is off, you can set it to on. FileDoor
  70. 3.01 will set it to X'FF' when the user used the tag-file and started a
  71. download. So make it good practice to check for X'FF' first (you can
  72. then delete the tag-file) and if not X'FF' test for TRUE or FALSE.
  73.